CheckRequiredData (input)
The CheckRequiredData object is submitted as part of the CheckRequiredData request message (input).
| Parameter | Type | Description |
|---|---|---|
| txn | string | This is the transaction data in a specific XML format. This should include any data points mapped from the application’s system that DocViewer will change. |
| docs | ArrayOfDocument | This is a list of documents that you want DocViewer to display. You can specify this list of documents if you wish to bypass autoselection rules. DocViewer will run the instancing rules in the documents and display all the matching document instances. The Id specified of each document can be shorthand (PKGD.SampleDocument) or longhand (expere://ORG.CustomOrg/PKGD.SampleDocument). If the shorthand is used, DocViewer will use the default org, so specifying the full URI may be necessary. |
| packages | ArrayOfPackage | If this argument is passed in, the docs argument will be ignored. Either this argument or docs must be passed in. This is the list of packages that will be used to run autoselection against. The package Ids, like document Ids, can be shorthand (PKG.SamplePackage) or longhand (expere://ORG.CustomOrg/ PKG.SamplePackage). If the shorthand is used, DocViewer will use the default org, so specifying the full URI may be necessary. |
| dictInfo | OverlayDictionaryInfo | This argument is used to specify an overlay dictionary to use during the DocViewer Interface session. This object contains the file name (with or without extension) and the precedence level (organization) it can be found at. This overlay dictionary must be present within that organization in the repository. If not found, DocViewer Interface will return an error and the session will not begin. |
| executeAutoSelection | Boolean | When set to "true," DocViewer runs autoselection when a list of documents is passed in. |